<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>RankingModel (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="RankingModel (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RankingModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/RankingModel.html" target="_top">Frames</a></li>
<li><a href="RankingModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.ranking.api</div>
<h2 title="Interface RankingModel" class="title">Interface RankingModel</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">RankingModel</span></pre>
<div class="block">Model for ranking data. 
 <p>
 That includes the list of rankings currently available,
 separated in categories with different element types. It can returns all rankings
 for nodes or edges, or any element type.
 <p>
 Rankings are builds thanks to <code>RankingBuilder</code> implementation. Implement
 a new <code>RankingBuider</code> service to create new rankings.
 <p>
 The model also hosts the currently defined interpolator.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api"><code>Ranking</code></a>, 
<a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api"><code>Transformer</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#addRankingListener(org.gephi.ranking.api.RankingListener)">addRankingListener</a></strong>(<a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api">RankingListener</a>&nbsp;listener)</code>
<div class="block">Add <code>listener</code> as a ranking listener of this model</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getAutoTransformerRanking(org.gephi.ranking.api.Transformer)">getAutoTransformerRanking</a></strong>(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</code>
<div class="block">If <code>transformer</code> is an auto transformer, returns the ranking
 associated to it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getEdgeRankings()">getEdgeRankings</a></strong>()</code>
<div class="block">Get all rankings for edge elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Interpolator.html" title="class in org.gephi.ranking.api">Interpolator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getInterpolator()">getInterpolator</a></strong>()</code>
<div class="block">Returns the current interpolator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getNodeRankings()">getNodeRankings</a></strong>()</code>
<div class="block">Get all rankings for node elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getRanking(java.lang.String, java.lang.String)">getRanking</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType,
          <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Return the specific ranking for <code>elementType</code> and with
 the given <code>name</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getRankings(java.lang.String)">getRankings</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType)</code>
<div class="block">Get all rankings for <code>elementType</code> elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getTransformer(java.lang.String, java.lang.String)">getTransformer</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType,
              <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the specific transformer for <code>elementType</code> and with the
 given <code>name</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getTransformers(java.lang.String)">getTransformers</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType)</code>
<div class="block">Return all transformers specific to <code>elementType</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#getWorkspace()">getWorkspace</a></strong>()</code>
<div class="block">Return the workspace this model is associated with</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#removeRankingListener(org.gephi.ranking.api.RankingListener)">removeRankingListener</a></strong>(<a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api">RankingListener</a>&nbsp;listener)</code>
<div class="block">Remove <code>listener</code> as a ranking listener of this model</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingModel.html#useLocalScale()">useLocalScale</a></strong>()</code>
<div class="block">Returns <code>true</code> if rankings are using the currently visible
 graph as a scale.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getNodeRankings()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeRankings</h4>
<pre><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]&nbsp;getNodeRankings()</pre>
<div class="block">Get all rankings for node elements. Rankings are classified with the type
 of element they are manipulating. Rankings specific to node elements are
 defined by the <code>Ranking.NODE_ELEMENT</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>All rankings for node elements</dd></dl>
</li>
</ul>
<a name="getEdgeRankings()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdgeRankings</h4>
<pre><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]&nbsp;getEdgeRankings()</pre>
<div class="block">Get all rankings for edge elements. Rankings are classified with the type
 of element they are manipulating. Rankings specific to edge elements are
 defined by the <code>Ranking.EDGE_ELEMENT</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>All rankings for edge elements</dd></dl>
</li>
</ul>
<a name="getRankings(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRankings</h4>
<pre><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>[]&nbsp;getRankings(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType)</pre>
<div class="block">Get all rankings for <code>elementType</code> elements. Rankings are 
 classified with the type of element they are manipulating. If 
 <code>elementType</code> equals <code>Ranking.NODE_ELEMENT</code> this is
 equivalent to <a href="../../../../org/gephi/ranking/api/RankingModel.html#getNodeRankings()"><code>getNodeRankings()</code></a> method</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementType</code> - the element type of the rankings</dd>
<dt><span class="strong">Returns:</span></dt><dd>All rankings for <code>elementType</code></dd></dl>
</li>
</ul>
<a name="getRanking(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRanking</h4>
<pre><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;getRanking(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType,
                 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Return the specific ranking for <code>elementType</code> and with
 the given <code>name</code>. Returns <code>null</code> if not found.
 <p>
 Default ranking names can be found in the <a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api"><code>Ranking</code></a> interface. For 
 attribute rankings, simply use the column identifier.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementType</code> - the element type of the ranking</dd><dd><code>name</code> - the name of the ranking</dd>
<dt><span class="strong">Returns:</span></dt><dd>the found ranking or <code>null</code> if not found</dd></dl>
</li>
</ul>
<a name="getTransformers(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransformers</h4>
<pre><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>[]&nbsp;getTransformers(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType)</pre>
<div class="block">Return all transformers specific to <code>elementType</code>. A transformer
 defines his ability to transformer different element types.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementType</code> - the element type of the transformers</dd>
<dt><span class="strong">Returns:</span></dt><dd>all transformers working with <code>elementType</code></dd></dl>
</li>
</ul>
<a name="getTransformer(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransformer</h4>
<pre><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;getTransformer(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;elementType,
                         <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Returns the specific transformer for <code>elementType</code> and with the
 given <code>name</code>. Returns <code>null</code> if not found.
 <p>
 Default transformers name can be found in the <a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api"><code>Transformer</code></a> interface.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>elementType</code> - the element type of the transformer</dd><dd><code>name</code> - the name of the transformer</dd>
<dt><span class="strong">Returns:</span></dt><dd>the transformer defined as <code>name</code> and <code>elementType</code>
 or <code>null</code> if not found</dd></dl>
</li>
</ul>
<a name="getInterpolator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInterpolator</h4>
<pre><a href="../../../../org/gephi/ranking/api/Interpolator.html" title="class in org.gephi.ranking.api">Interpolator</a>&nbsp;getInterpolator()</pre>
<div class="block">Returns the current interpolator. The default interpolator is a simple
 linear interpolation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current interpolator</dd></dl>
</li>
</ul>
<a name="getWorkspace()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkspace</h4>
<pre><a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a>&nbsp;getWorkspace()</pre>
<div class="block">Return the workspace this model is associated with</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the workspace of this model</dd></dl>
</li>
</ul>
<a name="useLocalScale()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useLocalScale</h4>
<pre>boolean&nbsp;useLocalScale()</pre>
<div class="block">Returns <code>true</code> if rankings are using the currently visible
 graph as a scale. If <code>false</code> the complete graph is used to determine
 minimum and maximum values, the ranking scale.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if using a local scale, <code>false</code> if
 global scale</dd></dl>
</li>
</ul>
<a name="getAutoTransformerRanking(org.gephi.ranking.api.Transformer)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutoTransformerRanking</h4>
<pre><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;getAutoTransformerRanking(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</pre>
<div class="block">If <code>transformer</code> is an auto transformer, returns the ranking
 associated to it.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transformer</code> - the transformer to obtain the ranking from</dd>
<dt><span class="strong">Returns:</span></dt><dd>the ranking associated to <code>transformer</code> or <code>null</code></dd></dl>
</li>
</ul>
<a name="addRankingListener(org.gephi.ranking.api.RankingListener)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRankingListener</h4>
<pre>void&nbsp;addRankingListener(<a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api">RankingListener</a>&nbsp;listener)</pre>
<div class="block">Add <code>listener</code> as a ranking listener of this model</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to add</dd></dl>
</li>
</ul>
<a name="removeRankingListener(org.gephi.ranking.api.RankingListener)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeRankingListener</h4>
<pre>void&nbsp;removeRankingListener(<a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api">RankingListener</a>&nbsp;listener)</pre>
<div class="block">Remove <code>listener</code> as a ranking listener of this model</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to remove</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RankingModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/RankingListener.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/RankingModel.html" target="_top">Frames</a></li>
<li><a href="RankingModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
